home *** CD-ROM | disk | FTP | other *** search
/ MacWorld UK 2000 March / MW_UK_2000_03.iso / Shareware World / Utilities / Text Processing / Alpha / Help / Filesets Help < prev    next >
Encoding:
Text File  |  1999-07-26  |  10.9 KB  |  253 lines  |  [TEXT/ALFA]
  1.                     Fileset Menu
  2.  
  3. Filesets are lists of files that Alpha uses for multiple-file searches and 
  4. tag searches, among other things.  Typically, a user will set up several 
  5. different file sets, perhaps one specifying all the source files in a 
  6. project, another specifying all the Mac include files, and another 
  7. specifying all the UNIX include files, and yet another one with all html 
  8. files in a home page.
  9.  
  10. Activating the Fileset menu
  11.  
  12. The Filesets menu is activated in the dialog "Config->Preferences->Menus
  13. and Features…" Check the checkbox 'Fileset Menu' among the global menus.
  14.  
  15. Getting started
  16.  
  17. As an introductory example this section describes how to create a new 
  18. fileset with all files in a folder.
  19. • Create a new fileset by selecting 'New Fileset…' in the Utilities submenu 
  20. of the Fileset Menu.
  21. • You are now asked which type of fileset you want. Select the 
  22. 'fromDirectory' to create a fileset with the files in a folder.
  23. • You are now asked to give the fileset a name. Let's give it the name 'My 
  24. fileset'.
  25. • Then you are asked to select the folder for the fileset.
  26. • Next you asked to give a pattern for the fileset specifying which files 
  27. to include in the folder to include in the fileset. To include file use the 
  28. default pattern '*'. See the section File Patterns in the Alpha manual to 
  29. learn about how to specify file patterns.
  30. • Next you are asked to specify a list of patterns for files you want to 
  31. exclude from the fileset but which was included by the file pattern you 
  32. just specified. Leave this blank for now.
  33. • Finally you are asked if you want save the fileset. Doing so will make 
  34. Alpha keep the fileset next time you run Alpha.
  35.  
  36. Alpha now builds a new submenu of the Fileset menu called 'My fileset' with 
  37. all you files in the folder. Selecting a file in the submenu will open the 
  38. file in Alpha.
  39.  
  40. Your fileset can also be used for multi-file searching. In the Find dialog 
  41. when selecting multi file searching, you can choose to search the files in 
  42. your fileset.
  43.  
  44. You can also do multi file search and replace in your fileset, by 
  45. selecting 'Replace In Fileset' in the Utilities menu.
  46.  
  47. Fileset types
  48.  
  49. Some fileset types require that you give file patterns specifying which 
  50. files to include in the fileset. Read the Section File Patterns in the 
  51. Alpha manual to learn about how to specify file patterns.
  52.  
  53. From Directory          The basic type: create a fileset of all files in a
  54.                         given folder which match a given pattern. You have to 
  55.                         specify:
  56.                         • The folder with the files.
  57.                         • A file pattern matching the files to include.
  58.                         • A list of patterns of files to exclude.
  59.                         
  60. From Hierarchy          Takes the above one step further and allows filesets
  61.                         to include all files in a nested set of folders.
  62.                         You have to specify:
  63.                         • The base folder with the files.
  64.                         • The depth of nested folders.
  65.                         • A file pattern matching the files to include.
  66.                         
  67. From Open Windows       Make a fileset containing all currently open windows.
  68.  
  69. Codewarrior             Query the Codewarrior IDE for a list of all files in
  70.                         the current project.
  71.                         
  72. Think                   Query the Symantec Project Manager for a list of all
  73.                         files in the current project.
  74.  
  75. Tex                     Make a fileset of all parts of a multi-part 
  76.                         TeX/LaTeX document. Alpha's LaTeX mode understands 
  77.                         these and will automatically send your TeX 
  78.                         application the base .tex/.ltx file when you select 
  79.                         'Typeset' on any component part. Details about TeX 
  80.                         filesets can be found in the LaTeX mode 
  81.                         documentation.
  82.  
  83. Ftp                     Make a fileset of files at a remote machine via 
  84.                         ftp. You have to specify:
  85.                         • Host, path (optional), user id, and password
  86.                         • A regular expression (not a file pattern!) 
  87.                         matching the files to include.
  88.  
  89. Procedural              Make a fileset from a Tcl procedure. This type 
  90.                         requires that you write a Tcl procedure which 
  91.                         returns a list of paths to all files in the 
  92.                         fileset. When you create a new procedural fileset 
  93.                         Alpha puts an empty procedure (with the correct 
  94.                         name!) in your global preferences file. You must 
  95.                         then write the body of this procedure. Procedural 
  96.                         filesets are completely dynamic and will not appear 
  97.                         in the Fileset menu.
  98.  
  99. The following items will be added to the utilities menu if you use 
  100. TeX filesets:
  101.  
  102. Extract Eps BoxSizes    search all document parts for included eps graphics,  
  103.                         extract bounding box information from the .eps files 
  104.                         and insert it explicitly into the document (can lead 
  105.                         to much quicker typesetting).
  106.                         
  107. Delete Eps Box Sizes    remove all the above bounding box information
  108.  
  109. Hierarchical Bib Files  bibliography files may \input others, so they should
  110.                         be searched (the default is not to do this, because
  111.                         .bib files may be enormous).
  112.  
  113. Non-text files
  114.  
  115. By default only text files are included in the fileset. If the flag 
  116. 'Include Non Text Files' is set, the fileset menu may contain files Alpha 
  117. is not designed to open; these are sent to the Finder which will open them 
  118. using whichever application created them.  A common use of this feature is 
  119. a hierarchical fileset containing a complete C or C++ project.  Selecting any 
  120. project source file will open that file for editing, and selecting the 
  121. project file/debugging symbol file/... will open that using appropriate 
  122. tool (Symantec Project Manager or Codewarrior IDE or Debugger,…) 
  123. Another use can be to include images in a home page so you can quickly 
  124. open them when you want to change the graphics.
  125.  
  126. Fileset cache
  127.  
  128. Rather than rebuilding the Fileset menu every time you launch Alpha, the 
  129. menu is saved in a cache file. This is to speed up launching of Alpha as 
  130. building the filesets may take a while if there are many of them. Therefore 
  131. the fileset submenus may become out of date and you have to rebuild them. 
  132. You can rebuild a single fileset either using 'Update Current Fileset' or 
  133. 'Update A Fileset…' or rebuild them all using 'Rebuild All Filesets'.
  134.  
  135. Current Fileset
  136.  
  137. Some functions that use filesets operate on the 'current' fileset. The 
  138. current file set can be selected in the 'Choose' submenu of the Utilities 
  139. menu. There is also a flag 'Auto Adjust Fileset' which will switch the 
  140. current filesets whenever the fileset menu is used to open a file.
  141.  
  142.  
  143.  
  144. Fileset Utilities
  145.  
  146. The fileset utilities menu contains the following items:
  147.  
  148. New Fileset…            create a new fileset of one of the above six 
  149.                         standard types (others may be added by writing your 
  150.                         own Tcl code, see below.)
  151.  
  152. Delete Fileset…         remove a fileset, permanently if desired.
  153.  
  154. Print Fileset…          print all files in a fileset
  155.  
  156. Update Current Fileset  re-build the current fileset from scratch
  157.  
  158. Update A Fileset        (hold down option) lets you choose a fileset to 
  159.                         rebuild.
  160.  
  161. Rebuild All Filesets    total menu rebuild.
  162.  
  163. Zap And Build Filesets  (hold down option) a more drastic version of the 
  164.                         above.
  165.  
  166. Choose                  a menu from which to set the current fileset.
  167.  
  168. Hide Fileset            if you have many filesets, some of which are only 
  169.                         used for searching purposes, you can remove them 
  170.                         from the menu.
  171.                         
  172. Fileset Flags           see below for an explanation of the flags.   
  173.  
  174. Find Tag                see Tags for information on this and the 
  175.                         following item.
  176. Create Tag File 
  177.  
  178. The items below may not all work for all types of filesets.
  179.  
  180. Browse Fileset…         opens a browser window containing all fileset items, 
  181.                         from which any can be opened.
  182.                         
  183. Close Entire Fileset…   close all windows which belong to a given fileset.
  184.  
  185. Fileset To Alpha…       convert all text files in a fileset to Alpha's creator.
  186.  
  187. Open Entire Fileset…    open all files in a fileset
  188.  
  189. Open Fileset Folder…    tells the Finder to open the base folder which 
  190.                         contains a fileset.
  191.                         
  192. Rename Fileset…         change a fileset's name
  193.  
  194. Replace In Fileset…     global search and replace in all files. Use this 
  195.                         item with care!
  196.                         
  197. Stuff Fileset…          If you have 'DropStuff' installed, you can archive a 
  198.                         fileset.
  199.                         
  200. Word Count              Count all words in a fileset 
  201.  
  202. The following flags may be set:
  203.  
  204. Auto Adjust Fileset     opening a file from the menu will adjust current 
  205.                         fileset
  206.  
  207. Include Non Text Files  files not of type 'TEXT' may be in the menu.
  208.  
  209. Indent Fileset Items    visually format submenus if appropriate.
  210.  
  211. Sort Fileset Items      force alphabetical ordering for all filesets
  212.  
  213. Sort Filesets By Type   structure the fileset menu in a user-defined, type-
  214.                         dependent fashion; see Personalisation.
  215.  
  216.  
  217. Personalisation
  218.  
  219. As well as adjusting the aforementioned flags, the fileset menu allows 
  220. complete user control of the structure of the menu in the following way: 
  221. Set the 'Sort Filesets By Type' flag, and set the variable 
  222. "filesetSortOrder" as follows:
  223.  
  224.    The structure of this variable dictates how the fileset
  225.    menu is structured:
  226.        
  227.        '{pattern p}' 
  228.            lists all filesets which match 'p'
  229.        '-' 
  230.            adds a separator line
  231.        '{list of types}' 
  232.            lists all filesets of those types.
  233.        '{submenu name sub-order-list}' 
  234.            adds a submenu with name 'name' and recursively
  235.            adds filesets to that submenu as given by the 
  236.            sub-order.
  237.            
  238.    Leading, trailing and double separators are automatically
  239.    removed.
  240.  
  241. For example, the default value of this variable (more as an example than 
  242. anything else) is:
  243.  
  244. set filesetSortOrder { {pattern *System} {pattern Packages} \
  245.                         {pattern Menus} {pattern Modes} {pattern Preferences} \
  246.                         - {tex} - {pattern *.cc} {submenu Headers {pattern *.h}} \
  247.                         - {fromDirectory think codewarrior ftp \
  248.                         fromOpenWindows fromHierarchy} * }
  249.                         
  250. You can and should over-ride this in your global preferences file (copy and 
  251. paste from here, then make your changes).
  252.  
  253.